Platform Explorer / Nuxeo Platform 2023.10

Operation Blob.SetMetadataFromContext (Write Metadata To Blob From Context)

Description

Write Metadata To Blob From Context given a processor name (or the default Nuxeo one) and given metadata, and return the updated Blob.
Operation id Blob.SetMetadataFromContext
AliasesBinary.WriteMetadataFromContext
Category Files
Label Write Metadata To Blob From Context
Requires
Since 7.1

Parameters

Name Description Type Required Default value
metadata Metadata to write into the input blob. properties yes  
ignorePrefix Ignore metadata prefixes or not boolean no  
processor The processor to execute for overriding the input blob. string no  

Signature

Inputs blob
Outputs blob

Implementation Information

Implementation Class Class: org.nuxeo.binary.metadata.internals.operations.WriteMetadataToBinaryFromContext
Contributing Component org.nuxeo.binary.metadata

JSON Definition

{
  "id" : "Blob.SetMetadataFromContext",
  "aliases" : [ "Binary.WriteMetadataFromContext" ],
  "label" : "Write Metadata To Blob From Context",
  "category" : "Files",
  "requires" : null,
  "description" : "Write Metadata To Blob From Context given a processor name (or the default Nuxeo one) and given metadata, and return the updated Blob.",
  "since" : "7.1",
  "url" : "Blob.SetMetadataFromContext",
  "signature" : [ "blob", "blob" ],
  "params" : [ {
    "name" : "metadata",
    "description" : "Metadata to write into the input blob.",
    "type" : "properties",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "ignorePrefix",
    "description" : "Ignore metadata prefixes or not",
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "processor",
    "description" : "The processor to execute for overriding the input blob.",
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  } ]
}